iDRAC 8/7 v2.40.40.40 RACADM CLI Guide

This chapter provides the database groups and objects that must be used with the get or set subcommands. When using the objects, they must begin with FQDD or FQDD alias.

The set operations for iDRAC, Lifecycle Controller and system objects do not require server restart. However, the set operations for NIC and BIOS objects are staged and job creation and server restart is required to apply and commit the pending values.

• While entering an attribute value that is more than one word, ensure that you enclose the attribute value within single quotation marks in the set command.

  Example:

  racadm>>set system.thermalsettings.ThermalProfile 'Maximum performance'
                                      racadm set system.thermalsettings.ThermalProfile 'Maximum performance'
                                      [Key=system.Embedded.1#ThermalSettings.1]
                                      Object value modified successfully
                                   

• The staged configuration has the associated pending value in the output of the get operation, after it is configured successfully.
• The object values in the BIOS and NIC groups are case-sensitive.
• For NIC objects, the definition of the key format is: Key = <Device Class>.<Locator>.<Device Number>—<Port Number>[-<Partition Number>]#GroupName” where,

  • Device Class: NIC

  • Locator: Integrated, Slot, Mezzanine or Embedded

    Example:

    $racadm get NIC.NICConfig
                                                 NIC.NICConfig.1 [Key=NIC.Integrated.1-1#NICConfig]
                                                 NIC.NICConfig.2 [Key=NIC.Integrated.1-2#NICConfig]
                                                 NIC.NICConfig.3 [Key=NIC.Integrated.1-3#NICConfig]
                                                 NIC.NICConfig.4 [Key=NIC.Integrated.1-4#NICConfig]
                                                 
                                              

• The link between the NIC instance and the corresponding key varies from system to system depending on the system configuration.
• The command racadm help provides a list of all the attributes along with the description.

• To view the help details of group level, enter the following command: racadm help <group name>

  Example:

  $racadm help NIC.NICConfig
                                      NICConfig       -- (null)
                                      These are the objects supported by the group
                                      ------------------------------------------------------------------------------
                                      BannerMessageTimeout      -- Specify the number of seconds that the OptionROM banner is displayed during POST.
                                      Usage                     -- Values from 0 - 14
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                      BootOptionROM             -- Controls the enablement of legacy Boot Protocols in the Option ROM.
                                      Usage                     -- Enabled; Disabled
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                      BootRetryCnt              -- Specify the number of retries to attempt in case of boot failure.
                                      Usage                     -- NoRetry - 0;1Retry - 1; 2Retries - 2;3Retries - 3;4Retries - 4; 5Retries - 5;6Retries- 6; IndefiniteRetries,
                                      Default - NoRetry
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                   

  BootStrapType             -- Specify the boot strap method used to boot to the operating system.
                                      Usage                     -- AutoDetect - 0;BBS - 1; Int18h - 2; Int19h- 3; Default - AutoDetect
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                      HideSetupPrompt           -- Specifies whether to display or hide the legacy Option ROM setup prompt during system Power On
                                      Self Test (POST).
                                      Usage                     -- Enabled; Disabled; Default - Disabled
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                      LegacyBootProto           -- Select a non-UEFI network boot protocol
                                      Usage                     -- PXE; iSCSI; FCoE; NONE; iSCSIPrimary; iSCSISecondary
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                   

  LnkSpeed                  -- Specifies the port speed used for the selected boot protocol
                                      Usage                     -- AutoNeg; 10Mbps Half; 10Mbps Full; 100Mbps Half; 100Mbps Full
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                      NumberVFAdvertised        -- The number of PCI Virtual Functions (VFs) to be advertised on this port in non-NPAR mode.
                                      Usage                     -- Values from 0 - 256, Default - 0
                                      Required License          -- RACADM
                                      Dependency                -- VLanMode has to be Enabled
                                      
                                      VLanId                    -- Specifies the ID (tag) for the VLAN Mode. VLAN ID must be in the range from 0 to 4095
                                      Usage                     -- Values from 1 - 4095
                                      Required License          -- RACADM
                                      Dependency                -- VLanMode has to be Enabled
                                      
                                   

  VLanMode                  -- Virtual LAN mode enables use of a VLAN tag to be used by [vendor defined boot protocols]
                                      Usage                     -- Enabled; Disabled
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                      WakeOnLan                 -- Enables the server to be powered on using an in-band magic packet
                                      Usage                     -- Enabled; Disabled
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                      WakeOnLanLnkSpeed         -- Select the port speed used for Wake on LAN mode
                                      Usage                     -- AutoNeg; 10Mbps Half; 10Mbps Full; 100Mbps Half; 100Mbps Full
                                      Required License          -- RACADM
                                      Dependency                -- None
                                      
                                   

• To view the help details of attribute level, enter the following command: racadm help <attribute name>

  Example:

  /tmp # racadm help NIC.NICConfig.WakeOnLanLnkSpeed 
                                      WakeOnLanLnkSpeed -- Select the port speed used for Wake on LAN mode
                                      Usage -- AutoNeg; 10Mbps Half; 10Mbps Full; 100Mbps Half; 100Mbps Full
                                      Required License -- RACADM
                                      Dependency -- None/tmp #
                                   

• The get and set commands for BIOS and NIC provide the list of attributes on the basis of the system configuration, BIOS version used, hardware, and so on.